Skip to main content

Room Types

The Room Types entity holds details about room-type(s) of a property including room information, number of units, amenities, property details and custom fields.

Fields​

FieldTypeDescription
idstring/numberIdentifier of the Room type
propertyIdstring/numberIdentifier of the property associated with a Room type
createdAtstringDate and time when the entry was created in ISO 8601 format
updatedAtstringDate and time when the entry was last updated in ISO 8601 format
namestringName of the Room type
descriptionstringDescription of the Room type
thumbnailUrlstringURL of the thumbnail image
picturesstring[]Picture URLs of the Room type and their descriptions
unitsstring[]Unit related details of the associated room type
maximumNightsnumberDefault maximum number of nights for booking the room type
minimumNightsnumberDefault minimum number of nights for booking the room type
maxOccupancynumberMaximum occupancy of the room type
startPricenumberStarting price for the room type
bedRoomobjectBedroom details of the room type
bathRoomobjectBathroom details of the room type
roomsobjectDetails about rooms of the room type
checkInobjectCheck-in details of the room type
checkOutobjectCheck-out details of the room type
wifiDetailsobjectWifi details of the room type
amenitiesobjectAmenities of the room type
roomTypeDetailsobjectDetails about the room type
agreementsobjectAgreements related to the room type
contactobjectContact information of the property manager or host
policyobjectPolicies of the room type
channelsobjectChannels where this room type is listed
othersobjectMiscellaneous details of the room type
customFieldsobjectCustom fields of the room type

Sub Fields​

units​

FieldTypeDescription
countnumberNo. of units within the room type.
data.idstring/numberIdentifier of the unit.
data.namestringName of the unit.
data.descriptionstringDescription of the unit.
data.maxOccupancynumberMaximum occupancy of the unit.

bedRoom​

FieldTypeDescription
typestringType of the bedroom.
countnumberNumber of bedrooms.
bedsCountnumberNumber of beds in the bedroom.

bathRoom​

FieldTypeDescription
typestringType of the bathroom.
countnumberNumber of bathrooms.

rooms​

FieldTypeDescription
idstring/numberIdentifier of the room.
namestringName of the room.
typestringType of the room.
roomNumbernumberRoom number.
maxOccupancynumberMaximum occupancy of the room.
beds.idstring/numberIdentifier of the bed in the room.
beds.namestringName of the bed.
beds.typestringType of the bed.
beds.countnumberNumber of beds in the room.

checkIn​

FieldTypeDescription
checkInStartstringStart time for check-in in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
checkInEndstringEnd time for check-in in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
checkInInstructionsstringInstructions for check-in.
checkInTypestringType of check-in.
checkInDescriptionstringDescription of check-in.
checkInPlacestringPlace for check-in.

checkOut​

FieldTypeDescription
checkOutStartstringStart time for check-out in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
checkOutEndstringEnd time for check-out in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
checkOutInstructionsstringInstructions for check-out.
checkOutTypestringType of check-out.
checkOutDescriptionstringDescription of check-out.
checkOutPlacestringPlace for check-out.

wifiDetails​

FieldTypeDescription
typestringType of wifi.
ssidstringSSID of the wifi.
passwordstringPassword for the wifi.

amenities​

FieldTypeDescription
idstring/numberIdentifier of the amenity.
namestringName of the amenity.
descriptionstringDescription of the amenity.
typestringType of the amenity.

roomTypeDetails​

FieldTypeDescription
directionsstringDirections to the room type.
manualstringManual for the room type.
instructionsstringInstructions for the room type.
rulesstringRules for the room type.
notesstringNotes for the room type.
spacestringSpace details of the room type.
accessstringAccess details of the room type.
interactionstringInteraction details of the room type.
neighborhoodstringNeighborhood details of the room type.
transitstringTransit details of the room type.
otherstringOther details of the room type.

Agreements​

FieldTypeDescription
isActivebooleanIndicates if the agreement is active.
idstringIdentifier of the agreement.
descriptionstringDescription of the agreement.

Contact​

FieldTypeDescription
namestringName of the contact.
firstNamestringFirst name of the contact.
lastNamestringLast name of the contact.
emailstring[]Array of email addresses.
phonestring[]Array of phone numbers.
addressstringAddress of the contact.
languagestringLanguage of the contact.
countrystringCountry of the contact.

Channels​

FieldTypeDescription
channelNamestringName of the channel.
channelListingIdstringListing ID in the channel.
channelListingUrlstringListing URL in the channel.

policy​

FieldTypeDescription
generalPolicystringGeneral policy of the room type.
privacyPolicystringPrivacy policies of the room type.
cancellationPolicyobjectCancellation policy of the room type.
securityDepositnumberSecurity deposit details of the room type.
paymentnumberPayment details of the room type.

CustomField​

FieldTypeDescription
idstringIdentifier of the custom field.
namestringName of the custom field.
typestringType of the custom field.
valuestringValue of the custom field.
defaultValuestringDefault value of the custom field.

Supported fields in each source system​

FieldHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSyncDirectYour RentalsMr AlfredReslyRentalWiseCloudbedsZeevou
id✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅
propertyId✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅
createdAt✅--✅✅✅-------✅-✅--✅-✅
updatedAt✅✅-✅-✅✅---✅--✅✅✅--✅-✅
name✅✅✅✅✅✅✅✅✅✅✅-✅✅✅✅✅✅✅✅✅
description✅✅-✅✅✅✅✅✅✅✅-✅✅✅✅✅✅✅✅✅
thumbnailUrl✅✅-✅-✅✅✅--✅✅--✅✅✅✅✅✅✅
pictures✅✅-✅✅✅✅✅-✅✅--✅✅✅✅✅✅✅✅
bedRoom✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅-✅
bathRoom✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅-✅
maximumNights✅✅---✅✅---✅----✅-----
minimumNights✅✅---✅✅---✅--✅-✅-----
maxOccupancy✅✅🔜✅✅✅✅✅--✅-✅✅-✅✅✅✅✅✅
startPrice✅✅✅✅✅✅✅✅--✅--✅-✅✅✅--✅
units🔶--✅_---✅---✅-✅---🔜✅✅
rooms✅✅-✅-✅✅✅🔜✅✅--✅✅✅--✅-✅
channels✅🔜🔜🔜🔜🔜🔶🔜🔜✅🔜🔜🔜🔜🔜🔜🔜🔜--🔶
checkIn✅✅-✅✅✅✅🔶✅✅✅--✅-✅✅🔶✅🔶✅
checkOut✅✅-✅✅✅✅✅✅-✅--✅-✅✅🔶✅🔶✅
wifiDetails✅✅---✅✅✅--✅-----✅✅--✅
amenities✅✅✅✅✅✅✅✅✅-✅-✅✅✅🔶✅✅✅✅✅
roomTypeDetails✅🔶-🔶-✅✅🔶-🔶🔶-🔜🔶-🔶🔶🔶🔶🔶🔶
agreements✅--✅----🔶----🔶-------
contact✅✅---✅🔜🔜✅✅✅-🔜✅🔜🔶---✅-
license✅--------------✅✅🔶🔶--
policy🔜🔶--🔶✅🔶✅✅-🔶--🔶--✅--🔶-
others✅✅--🔜✅✅---✅----✅✅----
customFields✅✅✅--✅✅✅🔜-✅-✅--✅--🔜-🔜

✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system


Supported Methods in each source system​

MethodsHostawayHostifySmoobuLodgifyUplistingGuestyHostfullyOwnerRezBeds24HospitableFantasticStayHostexElinaBookingSyncDirectYour RentalsMr AlfredReslyRentalWiseCloudbedsZeevou
Get Room Types of Property✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅

Note: This table is applicable only if you're using our Realtime APIs (Base APIs). If the Cached Database add-on is enabled in your workspace, all endpoints will be accessible across all PMS systems.